<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>AbstractCacheKeyGenerator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/ehcache/annotations/key/AbstractCacheKeyGenerator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright 2010 Nicholas Blair, Eric Dalquist</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> */</em>
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">package</strong> com.googlecode.ehcache.annotations.key;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.IdentityHashMap;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.aopalliance.intercept.MethodInvocation;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">/**</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * Base class for cache key generators. Handles common logic for including/excluding the method</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * signature from key generation. Also provides support for avoiding circular references for key</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * generators that traverse the argument object graph via the {@link #register(Object)} and</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * {@link #unregister(Object)} APIs </em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * </em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @author Eric Dalquist</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @version $Revision: 397 $</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> AbstractCacheKeyGenerator&lt;T <strong class="jxr_keyword">extends</strong> Serializable&gt; implements CacheKeyGenerator&lt;T&gt; {
<a name="36" href="#36">36</a>      <em class="jxr_comment">//Used by circular reference tracking register/unregister APIs</em>
<a name="37" href="#37">37</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> ThreadLocal&lt;Map&lt;Object, Object&gt;&gt; REGISTRY = <strong class="jxr_keyword">new</strong> ThreadLocal&lt;Map&lt;Object, Object&gt;&gt;() {
<a name="38" href="#38">38</a>          @Override
<a name="39" href="#39">39</a>          <strong class="jxr_keyword">protected</strong> Map&lt;Object, Object&gt; initialValue() {
<a name="40" href="#40">40</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> IdentityHashMap&lt;Object, Object&gt;();
<a name="41" href="#41">41</a>          }
<a name="42" href="#42">42</a>      };
<a name="43" href="#43">43</a>      
<a name="44" href="#44">44</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> checkforCycles = false;
<a name="45" href="#45">45</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeMethod = <strong class="jxr_keyword">true</strong>;
<a name="46" href="#46">46</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeParameterTypes = <strong class="jxr_keyword">true</strong>;
<a name="47" href="#47">47</a>      
<a name="48" href="#48">48</a>      <em class="jxr_javadoccomment">/**</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * Default constructor, same as calling {@link #AbstractCacheKeyGenerator(boolean, boolean)} with (true, true) </em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
<a name="51" href="#51">51</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/AbstractCacheKeyGenerator.html">AbstractCacheKeyGenerator</a>() {
<a name="52" href="#52">52</a>          <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">true</strong>, <strong class="jxr_keyword">true</strong>);
<a name="53" href="#53">53</a>      }
<a name="54" href="#54">54</a>      
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @see AbstractCacheKeyGenerator#setIncludeMethod(boolean)</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @see AbstractCacheKeyGenerator#setIncludeParameterTypes(boolean)</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/AbstractCacheKeyGenerator.html">AbstractCacheKeyGenerator</a>(<strong class="jxr_keyword">boolean</strong> includeMethod, <strong class="jxr_keyword">boolean</strong> includeParameterTypes) {
<a name="60" href="#60">60</a>          <strong class="jxr_keyword">this</strong>.includeMethod = includeMethod;
<a name="61" href="#61">61</a>          <strong class="jxr_keyword">this</strong>.includeParameterTypes = includeParameterTypes;
<a name="62" href="#62">62</a>      }
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isIncludeMethod() {
<a name="65" href="#65">65</a>          <strong class="jxr_keyword">return</strong> includeMethod;
<a name="66" href="#66">66</a>      }
<a name="67" href="#67">67</a>      <em class="jxr_javadoccomment">/**</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     * Determines if the invoked method signature should be included in the generated cache key. If</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * true {@link Method#getDeclaringClass()}, {@link Method#getName()}, and {@link Method#getReturnType()}</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * are included in the object array the key is generated from. Note that the effect of this option is</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * such that two methods with the same arguments will have different keys if true. If you have two methods</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * in the same class with the same name and return value you may want to enable {@link #setIncludeParameterTypes(boolean)}</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * for even more specific key generation.</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * </em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * Note that including the method signature in key generation reduces key generation speed.</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * </em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * @param includeMethod true If the {@link Method} from the {@link MethodInvocation} should be</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     *                      included in the generated key, defaults to true.</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * @see #setIncludeParameterTypes(boolean)</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     */</em>
<a name="81" href="#81">81</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setIncludeMethod(<strong class="jxr_keyword">boolean</strong> includeMethod) {
<a name="82" href="#82">82</a>          <strong class="jxr_keyword">this</strong>.includeMethod = includeMethod;
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>      
<a name="85" href="#85">85</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isIncludeParameterTypes() {
<a name="86" href="#86">86</a>          <strong class="jxr_keyword">return</strong> includeParameterTypes;
<a name="87" href="#87">87</a>      }
<a name="88" href="#88">88</a>      <em class="jxr_javadoccomment">/**</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * Determines if the method parameter types returned by {@link Method#getParameterTypes()} should be</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * included in the generated key. This is broken out into a separate option because the call results</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * in a clone() call on the Class[] every time {@link Method#getParameterTypes()} which reduces key</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * generation speed.</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * </em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * This is option is only used if {@link #setIncludeMethod(boolean)} is true.</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * </em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * @param includeParameterTypes true if the {@link Method#getParameterTypes()} should be included in</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     *                              the generated key, defaults to false.</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @see #setIncludeMethod(boolean)</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     */</em>
<a name="100" href="#100">100</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setIncludeParameterTypes(<strong class="jxr_keyword">boolean</strong> includeParameterTypes) {
<a name="101" href="#101">101</a>         <strong class="jxr_keyword">this</strong>.includeParameterTypes = includeParameterTypes;
<a name="102" href="#102">102</a>     }
<a name="103" href="#103">103</a>     
<a name="104" href="#104">104</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isCheckforCycles() {
<a name="105" href="#105">105</a>         <strong class="jxr_keyword">return</strong> checkforCycles;
<a name="106" href="#106">106</a>     }
<a name="107" href="#107">107</a>     <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * If the key generation should gracefully handle object graph cycles. If false the {@link #register(Object)} and</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * {@link #unregister(Object)} methods are non-functional. If true the implementation of this class must correctly</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * utilize the {@link #register(Object)} and {@link #unregister(Object)} methods to track visited objects.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * </em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @param checkforCycles Defaults to false.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     */</em>
<a name="114" href="#114">114</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> setCheckforCycles(<strong class="jxr_keyword">boolean</strong> checkforCycles) {
<a name="115" href="#115">115</a>         <strong class="jxr_keyword">this</strong>.checkforCycles = checkforCycles;
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="119" href="#119">119</a> <em class="jxr_comment">     * @see com.googlecode.ehcache.annotations.key.CacheKeyGenerator#generateKey(org.aopalliance.intercept.MethodInvocation)</em>
<a name="120" href="#120">120</a> <em class="jxr_comment">     */</em>
<a name="121" href="#121">121</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> T generateKey(MethodInvocation methodInvocation) {
<a name="122" href="#122">122</a>         <strong class="jxr_keyword">final</strong> Object[] arguments = methodInvocation.getArguments();
<a name="123" href="#123">123</a>         
<a name="124" href="#124">124</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.includeMethod) {
<a name="125" href="#125">125</a>             <strong class="jxr_keyword">final</strong> Method method = methodInvocation.getMethod();
<a name="126" href="#126">126</a>             
<a name="127" href="#127">127</a>             <strong class="jxr_keyword">final</strong> Class&lt;?&gt; declaringClass = method.getDeclaringClass();
<a name="128" href="#128">128</a>             <strong class="jxr_keyword">final</strong> String name = method.getName();
<a name="129" href="#129">129</a>             <strong class="jxr_keyword">final</strong> Class&lt;?&gt; returnType = method.getReturnType();
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.includeParameterTypes) {
<a name="132" href="#132">132</a>                 <strong class="jxr_keyword">final</strong> Class&lt;?&gt;[] parameterTypes = method.getParameterTypes();
<a name="133" href="#133">133</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.generateKey(declaringClass, name, returnType, parameterTypes, arguments);
<a name="134" href="#134">134</a>             }
<a name="135" href="#135">135</a>             
<a name="136" href="#136">136</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.generateKey(declaringClass, name, returnType, arguments);
<a name="137" href="#137">137</a>         }
<a name="138" href="#138">138</a>         
<a name="139" href="#139">139</a>         <strong class="jxr_keyword">try</strong> {
<a name="140" href="#140">140</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.generateKey(arguments);
<a name="141" href="#141">141</a>         }
<a name="142" href="#142">142</a>         <strong class="jxr_keyword">finally</strong> {
<a name="143" href="#143">143</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.checkforCycles) {
<a name="144" href="#144">144</a>                 <em class="jxr_comment">//Cleanup our thread local data</em>
<a name="145" href="#145">145</a>                 REGISTRY.remove();
<a name="146" href="#146">146</a>             }
<a name="147" href="#147">147</a>         }
<a name="148" href="#148">148</a>     }
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>     
<a name="151" href="#151">151</a>     <em class="jxr_javadoccomment">/**</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * Registers the given object. Used by the reflection methods to avoid infinite loops.</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * </em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * @param element The object to register.</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * @return true if the object is not currently registered</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     */</em>
<a name="159" href="#159">159</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> register(Object element) {
<a name="160" href="#160">160</a>         <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.checkforCycles) {
<a name="161" href="#161">161</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="162" href="#162">162</a>         }
<a name="163" href="#163">163</a>         
<a name="164" href="#164">164</a>         <strong class="jxr_keyword">final</strong> Map&lt;Object, Object&gt; registry = REGISTRY.get();
<a name="165" href="#165">165</a>         <strong class="jxr_keyword">return</strong> registry.put(element, element) == <strong class="jxr_keyword">null</strong>;
<a name="166" href="#166">166</a>     }
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>     <em class="jxr_javadoccomment">/**</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Unregisters the given object. Used by the reflection methods to avoid infinite loops.</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     */</em>
<a name="173" href="#173">173</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> unregister(Object element) {
<a name="174" href="#174">174</a>         <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.checkforCycles) {
<a name="175" href="#175">175</a>             <strong class="jxr_keyword">return</strong>;
<a name="176" href="#176">176</a>         }
<a name="177" href="#177">177</a>         
<a name="178" href="#178">178</a>         <strong class="jxr_keyword">final</strong> Map&lt;Object, Object&gt; registry = REGISTRY.get();
<a name="179" href="#179">179</a>         registry.remove(element);
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a>     
<a name="182" href="#182">182</a>     <em class="jxr_javadoccomment">/**</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * Called to generate the key. Depending on the {@link #setIncludeMethod(boolean)} and </em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * {@link #setIncludeParameterTypes(boolean)} the the appropriate parts of the {@link Method}</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * signature will be included in the data array.</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * </em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     *  @return The {@link Serializable} cache key for the method invocation.</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     */</em>
<a name="189" href="#189">189</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> T generateKey(Object... data);
<a name="190" href="#190">190</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

